<!DOCTYPE html>
<html >

<head>

  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <title>Classe LaTeX para formatação de documentos acadêmicos da UFRuralRJ</title>
  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
  <meta name="description" content="Manual de uso da classe LaTeX UFRuralRJ para formatação de documentos acadêmicos da Universidade Federal Rural do Rio de Janeiro.">
  <meta name="generator" content="bookdown 0.0.65 and GitBook 2.6.7">

  <meta property="og:title" content="Classe LaTeX para formatação de documentos acadêmicos da UFRuralRJ" />
  <meta property="og:type" content="book" />
  
  
  <meta property="og:description" content="Manual de uso da classe LaTeX UFRuralRJ para formatação de documentos acadêmicos da Universidade Federal Rural do Rio de Janeiro." />
  <meta name="github-repo" content="samuel-rosa/UFRuralRJ" />

  <meta name="twitter:card" content="summary" />
  <meta name="twitter:title" content="Classe LaTeX para formatação de documentos acadêmicos da UFRuralRJ" />
  
  <meta name="twitter:description" content="Manual de uso da classe LaTeX UFRuralRJ para formatação de documentos acadêmicos da Universidade Federal Rural do Rio de Janeiro." />
  

<meta name="author" content="Alessandro Samuel-Rosa">

<meta name="date" content="2016-04-20">


  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="apple-mobile-web-app-capable" content="yes">
  <meta name="apple-mobile-web-app-status-bar-style" content="black">
  
  
<link rel="prev" href="preambulo.html">


<script src="libs/jquery-2.2.3/jquery.min.js"></script>
<link href="libs/gitbook-2.6.7/css/style.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-bookdown.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-highlight.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-search.css" rel="stylesheet" />
<link href="libs/gitbook-2.6.7/css/plugin-fontsettings.css" rel="stylesheet" />










<link rel="stylesheet" href="style.css" type="text/css" />
</head>

<body>


  <div class="book without-animation with-summary font-size-2 font-family-1" data-basepath=".">

    <div class="book-summary">
      <nav role="navigation">

<ul class="summary">
<li><a href="./">Formatação de documentos acadêmicos da UFRuralRJ</a></li>

<li class="divider"></li>
<<<<<<< HEAD
<li class="chapter" data-level="1" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i><b>1</b> Apresentação</a><ul>
<li class="chapter" data-level="1.1" data-path="index.html"><a href="index.html#como-contribuir"><i class="fa fa-check"></i><b>1.1</b> Como contribuir</a></li>
</ul></li>
<li class="chapter" data-level="2" data-path="pre.html"><a href="pre.html"><i class="fa fa-check"></i><b>2</b> Pré-requisitos</a></li>
<li class="chapter" data-level="3" data-path="preambulo.html"><a href="preambulo.html"><i class="fa fa-check"></i><b>3</b> Preâmbulo</a><ul>
<li class="chapter" data-level="3.1" data-path="preambulo.html"><a href="preambulo.html#tipo-de-documento"><i class="fa fa-check"></i><b>3.1</b> Tipo de documento</a></li>
<li class="chapter" data-level="3.2" data-path="preambulo.html"><a href="preambulo.html#pacotes"><i class="fa fa-check"></i><b>3.2</b> Pacotes</a></li>
<li class="chapter" data-level="3.3" data-path="preambulo.html"><a href="preambulo.html#dados-para-elementos-pre-textuais"><i class="fa fa-check"></i><b>3.3</b> Dados para elementos pré-textuais</a></li>
</ul></li>
<li class="chapter" data-level="4" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html"><i class="fa fa-check"></i><b>4</b> Corpo do Documento Acadêmico</a><ul>
<li class="chapter" data-level="4.1" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#elementos-pre-textuais-obrigatorios"><i class="fa fa-check"></i><b>4.1</b> Elementos pré-textuais obrigatórios</a></li>
<li class="chapter" data-level="4.2" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#elementos-pre-textuais-opcionais"><i class="fa fa-check"></i><b>4.2</b> Elementos pré-textuais opcionais</a></li>
<li class="chapter" data-level="4.3" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#mais-elementos-pre-textuais-obrigatorios"><i class="fa fa-check"></i><b>4.3</b> Mais elementos pré-textuais obrigatórios</a><ul>
<li class="chapter" data-level="4.3.1" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#resumo-do-documento-academico"><i class="fa fa-check"></i><b>4.3.1</b> Resumo do documento acadêmico</a></li>
<li class="chapter" data-level="4.3.2" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#listas-e-sumario"><i class="fa fa-check"></i><b>4.3.2</b> Listas e sumário</a></li>
</ul></li>
<li class="chapter" data-level="4.4" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#corpo-principal-do-documento-academico"><i class="fa fa-check"></i><b>4.4</b> Corpo principal do documento acadêmico</a></li>
=======
<li class="chapter" data-level="1" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i><b>1</b> Apresentação</a></li>
<li class="chapter" data-level="2" data-path="pre.html"><a href="pre.html"><i class="fa fa-check"></i><b>2</b> Pré-requisitos</a></li>
<li class="chapter" data-level="3" data-path="preambulo.html"><a href="preambulo.html"><i class="fa fa-check"></i><b>3</b> Preâmbulo</a><ul>
<li class="chapter" data-level="3.1" data-path="preambulo.html"><a href="preambulo.html#definicoes-gerais-e-pacotes"><i class="fa fa-check"></i><b>3.1</b> Definições gerais e pacotes</a></li>
<li class="chapter" data-level="3.2" data-path="preambulo.html"><a href="preambulo.html#dados-para-os-elementos-pre-textuais"><i class="fa fa-check"></i><b>3.2</b> Dados para os elementos pré-textuais</a></li>
</ul></li>
<li class="chapter" data-level="4" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html"><i class="fa fa-check"></i><b>4</b> Corpo do Documento Acadêmico</a><ul>
<li class="chapter" data-level="4.0.1" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#elementos-pre-textuais-obrigatorios"><i class="fa fa-check"></i><b>4.0.1</b> Elementos pré-textuais obrigatórios</a></li>
<li class="chapter" data-level="4.0.2" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#elementos-pre-textuais-opcionais"><i class="fa fa-check"></i><b>4.0.2</b> Elementos pré-textuais opcionais</a></li>
<li class="chapter" data-level="4.0.3" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#mais-elementos-pre-textuais-obrigatorios"><i class="fa fa-check"></i><b>4.0.3</b> Mais elementos pré-textuais obrigatórios</a></li>
<li class="chapter" data-level="4.0.4" data-path="corpo-do-documento-academico.html"><a href="corpo-do-documento-academico.html#corpo-principal-do-documento-academico"><i class="fa fa-check"></i><b>4.0.4</b> Corpo principal do documento acadêmico</a></li>
>>>>>>> 363b502b51f532807f4d814ed483ac011060065c
</ul></li>
<li class="divider"></li>
<li><a href="https://github.com/rstudio/bookdown" target="blank">Publicado com bookdown</a></li>

</ul>

      </nav>
    </div>

    <div class="book-body">
      <div class="body-inner">
        <div class="book-header" role="navigation">
          <h1>
            <i class="fa fa-circle-o-notch fa-spin"></i><a href="./">Classe LaTeX para formatação de documentos acadêmicos da UFRuralRJ</a>
          </h1>
        </div>

        <div class="page-wrapper" tabindex="-1" role="main">
          <div class="page-inner">

            <section class="normal" id="section-">
<div id="corpo-do-documento-academico" class="section level1">
<h1><span class="header-section-number">Capítulo 4</span> Corpo do Documento Acadêmico</h1>
<p>Em seu documento principal (<em>master</em>), o início do documento acadêmico propriamente dito é marcado pelo seguinte comando:</p>
<pre><code>%% Início do documento
\begin{document}</code></pre>
<p>Já o fim do documento acadêmico é marcado por:</p>
<pre><code>%% Fim do documento
\end{document}</code></pre>
<p>Assim sendo, tudo aquilo que constitui o documento acadêmico, sejam eles elementos pré-textuais, textuais, e pós-textuais, são inserido entre os comandos <code>\begin{document}</code> e <code>\end{document}</code>.</p>
<<<<<<< HEAD
<div id="elementos-pre-textuais-obrigatorios" class="section level2">
<h2><span class="header-section-number">4.1</span> Elementos pré-textuais obrigatórios</h2>
=======
<div id="elementos-pre-textuais-obrigatorios" class="section level3">
<h3><span class="header-section-number">4.0.1</span> Elementos pré-textuais obrigatórios</h3>
>>>>>>> 363b502b51f532807f4d814ed483ac011060065c
<p>Você precisa informar <code>UFRuralRJ</code> onde os elementos pré-textuais devem ser inseridos. Para isso, basta usar os seguintes comandos (nesta ordem):</p>
<pre><code>%% Inserir capa, folha de rosto, e folha de aprovação
\maketitle
\makeapprove</code></pre>
<p>Pronto!!! Desde que todas as informações necessárias tenham sido passadas à <code>UFRuralRJ</code> acima, no preâmbulo do seu documento principal, os dois simples comandos <code>\maketitle</code> e <code>\makeapprove</code> se encarregarão do serviço de formatar e posicionar no local correto a capa, a folha de rosto, e a folha de aprovação do seu documento acadêmico, sem que você tenha que fazer qualquer esforço. Mas lembre-se de que eles devem ser inseridos sempre após <code>\begin{document}</code>.</p>
</div>
<<<<<<< HEAD
<div id="elementos-pre-textuais-opcionais" class="section level2">
<h2><span class="header-section-number">4.2</span> Elementos pré-textuais opcionais</h2>
</div>
<div id="mais-elementos-pre-textuais-obrigatorios" class="section level2">
<h2><span class="header-section-number">4.3</span> Mais elementos pré-textuais obrigatórios</h2>
<div id="resumo-do-documento-academico" class="section level3">
<h3><span class="header-section-number">4.3.1</span> Resumo do documento acadêmico</h3>
=======
<div id="elementos-pre-textuais-opcionais" class="section level3">
<h3><span class="header-section-number">4.0.2</span> Elementos pré-textuais opcionais</h3>
</div>
<div id="mais-elementos-pre-textuais-obrigatorios" class="section level3">
<h3><span class="header-section-number">4.0.3</span> Mais elementos pré-textuais obrigatórios</h3>
<div id="resumo-do-documento-academico" class="section level4">
<h4><span class="header-section-number">4.0.3.1</span> Resumo do documento acadêmico</h4>
>>>>>>> 363b502b51f532807f4d814ed483ac011060065c
<p>Um importante elemento pré-textual obrigatório é o resumo do documento acadêmico. A classe <code>UFRuralRJ</code> possui dois tipos de resumo, cada um pensado para um tipo de documento acadêmico. O primeiro deles é o que chamamos de <em>resumo geral</em>. O resumo geral é usado em documentos acadêmicos construídos usando capítulos individuais, ou seja, capítulos preparados de maneira que possam ser lidos individualmente, muitas vezes baseados em trabalhos publicados em revistas científicas na forma de artigo, revisão bibliográfica, ou nota científica. O outro tipo de resumo do documento acadêmico oferecido por <code>UFRuralRJ</code> é o que chamamos de <em>resumo simples</em>, o qual corresponde ao resumo de todo o documento acadêmico quando o mesmo é construído a partir de capítulos sequenciais, ou seja, como .</p>
<p>Consideremos o exemplo acima, onde nosso documento acadêmico constitui uma tese de doutorado composta por capítulos individuais. Nesse caso, usa-se o <em>resumo geral</em>, primeiro em português:</p>
<pre><code>%% Definições do resumo geral
\def\tituloPT{UFRuralRJ -- Classe \LaTeX{} para formatação de documentos acadêmicos na UFRRJ}
\def\chavesPT{\LaTeX. UFRuralRJ. Documentos acadêmicos}
\def\nivelPT{Doutorado em Agronomia, Ciência do Solo}

%% Resumo geral
\generalabstracttrue
\begin{generalabstract}{brazilian}{\tituloPT}{\chavesPT}{\nivelPT}
Este é o resumo geral em português de uma tese organizada na forma de capítulos individuais.
\end{generalabstract}</code></pre>
<p>Depois em inglês:</p>
<pre><code>%% General abstract definitions
\def\tituloEN{UFRuralRJ -- \LaTeX{} class for formatting academic documents at UFRRJ}
\def\chavesEN{\LaTeX. UFRuralRJ. Academical documents}
\def\nivelEN{Doctor of Science in Agronomy, Soil Science}

%% General abstract
\generalabstracttrue
\begin{generalabstract}{english}{\tituloEN}{\chavesEN}{\nivelEN}
This is the English abstract of a thesis organized in the form of individual chapters.
\end{generalabstract}</code></pre>
<p>Primeiro, vejamos qual a diferença entre o <em>resumo geral</em> e o <em>resumo simples</em>. Note, nos exemplos acima, a macro <code>\generalabstracttrue</code>. É esta macro a responsável por informar à <code>UFRuralRJ</code> que o resumo que estamos construindo é do tipo geral ao invés de simples. Assim, no caso de <em>resumo simples</em>, basta remover a macro <code>\generalabstracttrue</code>, ou usar <code>\generalabstractfalse</code>. Simples assim!!!</p>
<p>Vejamos agora os outros elementos usados para definir o resumo de nosso documento acadêmico. Para ambos o <em>resumo geral</em> e o <em>resumo simples</em>, o resumo do documento acadêmico sempre é construído usando o ambiente <code>generalabstract</code>, o qual aceita cinco informações: o idioma do resumo, o título do documento acadêmico, as palavras-chave, o nível do grau obtido, e o texto do resumo.</p>
<pre><code>\begin{generalabstract}{&lt;idioma&gt;}{&lt;titulo&gt;}{&lt;palavras-chaves&gt;}{&lt;nivel&gt;}
&lt;texto&gt;
\end{generalabstract}</code></pre>
<p>Com exceção do texto do resumo, todas as outras informações são passadas entre chaves, conforme demonstrado acima. A soma dessas informações geralmente resulta em um linha bastante longa. A fim de facilitar a manipulação e leitura de nosso documento, podemos usar as funcionalidades do LaTeX e criar definições para cada um dos itens do resumo usando o comando <a href="https://en.wikibooks.org/wiki/TeX/def"><code>\def</code></a>. Aqui, o comando <code>\def</code> recebe dois argumentos: o primeiro é a identificação daquilo que estamos definindo; o segundo é o seu conteúdo. Assim, o comando</p>
<pre><code>\def\chavesPT{\LaTeX. UFRuralRJ. Documentos acadêmicos}</code></pre>
<p>resulta na definição de um novo comando chamado <code>\chavesPT</code>, o qual contém as palavras-chave em português, tal qual definido em <code>{\LaTeX. UFRuralRJ. Documentos acadêmicos}</code>. A função do novo comando <code>\chavesPT</code> é inserir, no local onde for usado, as palavras-chave em português. (Note que o uso de <code>\def</code> é puramente estética.)</p>
</div>
<<<<<<< HEAD
<div id="listas-e-sumario" class="section level3">
<h3><span class="header-section-number">4.3.2</span> Listas e sumário</h3>
=======
<div id="listas-e-sumario" class="section level4">
<h4><span class="header-section-number">4.0.3.2</span> Listas e sumário</h4>
>>>>>>> 363b502b51f532807f4d814ed483ac011060065c
<p>Os últimos elementos pré-textuais obrigatórios são as listas e os sumários. Atualmente, <code>UFRuralRJ</code> suporta o uso de quatro tipos de listas: figuras, tabelas, apêndices, e anexos. Para inserir essas listas no documento basta usar os seguintes comandos:</p>
<pre><code>\listoffigures  %% Lista de figuras
\listoftables   %% Lista de tabelas
\listofappendix %% Lista de apêndices
\listofannex    %% Lista de anexos</code></pre>
<p>Para inserir o <a href="https://en.wikibooks.org/wiki/LaTeX/Document_Structure#Table_of_contents">sumário</a>, basta usar o seguinte comando:</p>
<pre><code>\tableofcontents</code></pre>
<p>Novamente, tudo muito simples, graças à capacidade de <code>UFRuralRJ</code> identificar, automaticamente, quais itens ao longo do texto pertencem a cada lista ou ao sumário. Caso seu documento não possua figuras, tabelas, apêndices, ou anexos, basta remover o respectivo comando mostrado acima.</p>
</div>
</div>
<<<<<<< HEAD
<div id="corpo-principal-do-documento-academico" class="section level2">
<h2><span class="header-section-number">4.4</span> Corpo principal do documento acadêmico</h2>
=======
<div id="corpo-principal-do-documento-academico" class="section level3">
<h3><span class="header-section-number">4.0.4</span> Corpo principal do documento acadêmico</h3>
>>>>>>> 363b502b51f532807f4d814ed483ac011060065c
<p>O corpo principal do documento acadêmico é constituído pelo texto propriamente dito, isto é, aquilo que você escreveu a cerca de suas experiências científicas ao longo dos anos de seu curso. A forma de organização desse texto pode variar conforme descrito acima. Também existem diferentes maneira de você gerenciar esse texto. Uma delas é redigindo todo o texto no seu documento <code>*.tex</code> principal. Contudo, do ponto de vista organizacional, essa não é uma boa estratégia pois o seu documento <code>*.tex</code> principal ficará extremamente longo, dificultando a navegação ao longo do mesmo. Além disso, um documento muito longo acaba usando grande quantidade da memória do seu computador.</p>
<p>A melhor estratégia de gerenciar o texto de seu documento acadêmico é usar um arquivo individual para cada parte ou capítulo. Especificamente, você usa um arquivo <code>*.tex</code> individual para escrever a Introdução Geral, outro arquivo <code>*.tex</code> para o Capítulo I, outro arquivo <code>*.tex</code> para as Conclusões Gerais, e assim por diante. Apesar do exemplo para documentos acadêmicos organizados na forma de capítulos individuais, o mesmo se aplica para documentos em texto corrido. Por exemplo, imagine que você escreveu tese com cinco grandes partes principais: Introdução, Revisão da Literatura, Material e Métodos, Resultados, Discussão, e Conclusões. Basta escrever cada uma dessas grandes partes principais em um arquivo <code>*.tex</code> individual.</p>
<p>Os arquivos <code>*.tex</code> individuais usados para redigir cada capítulo ou cada grande parte principal do documento acadêmico devem ser armazenados em um diretório também individual a fim de garantir melhor organização do trabalho. Feito isso, basta usar o comando <a href="https://en.wikibooks.org/wiki/LaTeX/Modular_Documents#Getting_LaTeX_to_process_multiple_files"><code>\include</code></a>, conforme segue:</p>
<pre><code>%% Incluir texto do corpo principal
\include{capitulos/introducao.tex}
\include{capitulos/capitulo01.tex}
\include{capitulos/capitulo02.tex}
\include{capitulos/conclusao.tex}</code></pre>
<p>No nosso exemplo, todos os arquivos <code>*.tex</code> individuais estão armazenados em um diretório chamado <code>capitulos</code>. Os nomes dos arquivos permitem adivinhar o seu conteúdo. Aqui, o comando <code>\include</code> cumprirá a tarefa de incluir, exatamente neste ponto do documento, o conteúdo da Introdução Geral, dos dois capítulos, e da Conclusão Geral. Se, por acaso, mais tarde, você e seus orientadores decidirem modificar a ordem dos capítulos no documento acadêmico, basta alterar a ordem em que cada arquivo <code>*.tex</code> é incluído. Simples assim!</p>
<p>O último item do corpo principal do documento acadêmico é a lista de referências bibliográficas. Para inserir essa lista no seu documento acadêmico basta usar simples o comando <a href="https://en.wikibooks.org/wiki/LaTeX/Bibliography_Management"><code>\bibliography</code></a>:</p>
<pre><code>%% Inserir lista de referências bibliográficas
\bibliography{referencias/biblio.bib}</code></pre>
<p>onde <code>referencias</code> é o nome do diretório onde se encontra sua base de dados de referências bibliográficas no formato <a href="https://en.wikibooks.org/wiki/LaTeX/Bibliography_Management#BibTeX">BibTeX</a>, e <code>biblio.bib</code> é o nome dessa base de dados de referências bibliográficas.</p>

<div id="refs" class="references">

</div>
</div>
</div>
            </section>

          </div>
        </div>
      </div>
<a href="preambulo.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page"><i class="fa fa-angle-left"></i></a>


<script src="libs/gitbook-2.6.7/js/app.min.js"></script>
<script src="libs/gitbook-2.6.7/js/lunr.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-search.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-sharing.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-fontsettings.js"></script>
<script src="libs/gitbook-2.6.7/js/plugin-bookdown.js"></script>
<script src="libs/gitbook-2.6.7/js/jquery.highlight.js"></script>
<script>
require(["gitbook"], function(gitbook) {
gitbook.start({
"sharing": {
"facebook": true,
"twitter": true,
"google": false,
"weibo": false,
"instapper": false,
"vk": false,
"all": ["facebook", "google", "twitter", "weibo", "instapaper"]
},
"fontsettings": {
"theme": "white",
"family": "sans",
"size": 2
},
"edit": {
"link": "https://github.com/rstudio/bookdown-demo/edit/master/03-corpo.Rmd",
"text": null
},
"download": ["ufrrj-class.pdf", "ufrrj-class.epub"],
"toc": {
"collapse": "subsection"
}
});
});
</script>

</body>

</html>
